﻿// -------------------------------------------------------------------------------------------------------------------------------
// <copyright file="IterationData{T}.cs" company="Exul">
//     Copyright (c) Exul. All rights reserved.
// </copyright>
// <author>
//     Exul
// </author>
// -------------------------------------------------------------------------------------------------------------------------------

namespace ExulLibrary.Mathematics.LinearAlgebra
{
    /// <summary>
    ///     Represents data about iterations of a solver.
    /// </summary>
    /// <typeparam name="T">
    ///     The type of elements of a system that is solving by the solver.
    /// </typeparam>
    public sealed class IterationData<T>
    {
        #region Properties

        #region public

        /// <summary>
        ///     Gets or sets the index of the current iterations.
        /// </summary>
        /// <value>
        ///     The index of the current iterations.
        /// </value>
        public int IterationIndex
        {
            get;
            set;
        }

        /// <summary>
        ///     Gets or sets the residual of the solution on the current iteration.
        /// </summary>
        /// <value>
        ///     The residual of the solution on the current solution.
        /// </value>
        public T Residual
        {
            get;
            set;
        }

        #endregion

        #endregion
    }
}